<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>py2ecotect.obj._object._ObjectRootFunc</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="py2ecotect-module.html">Package&nbsp;py2ecotect</a> ::
        <a href="py2ecotect.obj-module.html">Package&nbsp;obj</a> ::
        <a href="py2ecotect.obj._object-module.html" onclick="show_private();">Module&nbsp;_object</a> ::
        Class&nbsp;_ObjectRootFunc
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="py2ecotect.obj._object._ObjectRootFunc-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class _ObjectRootFunc</h1><p class="nomargin-top"><span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_ObjectRootFunc">source&nbsp;code</a></span></p>
<pre class="base-tree">
object --+
         |
        <strong class="uidshort">_ObjectRootFunc</strong>
</pre>

<dl><dt>Known Subclasses:</dt>
<dd>
      <ul class="subclass-list">
<li><a href="py2ecotect.obj._object._Object.func-class.html">_Object.func</a></li>  </ul>
</dd></dl>

<hr />
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.obj._object._ObjectRootFunc-class.html#get_distance_to" class="summary-sig-name">get_distance_to</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">absolute_position</span>)</span><br />
      Returns a single floating point value, being the distance between the
      specified object and the specified 3D point.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_ObjectRootFunc.get_distance_to">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.obj._object._ObjectRootFunc-class.html#get_incidence" class="summary-sig-name">get_incidence</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">coordinates</span>)</span><br />
      Returns the angle in degrees between the surface normal of the 
      specified object and the nominated 3D point.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_ObjectRootFunc.get_incidence">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.obj._object._ObjectRootFunc-class.html#get_inside" class="summary-sig-name">get_inside</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">coordinates</span>,
        <span class="summary-sig-arg">checkChildren</span>=<span class="summary-sig-default">True</span>)</span><br />
      Determines if the specified point is within the boundary of the 
      specified object, either 0 for false or 1 for true.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_ObjectRootFunc.get_inside">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.obj._object._ObjectRootFunc-class.html#get_intersect" class="summary-sig-name">get_intersect</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">coordinates_start</span>,
        <span class="summary-sig-arg">coordinates_end</span>)</span><br />
      Returns the coordinates of the intersection point between a line 
      joining the two nominated points with the plane of the specified 
      object.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_ObjectRootFunc.get_intersect">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.obj._object._ObjectRootFunc-class.html#get_pt_initialise" class="summary-sig-name">get_pt_initialise</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">fraction</span>)</span><br />
      Many analysis functions require a range of sample points distributed 
      over an object's surface or along its length.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_ObjectRootFunc.get_pt_initialise">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.obj._object._ObjectRootFunc-class.html#get_reflect" class="summary-sig-name">get_reflect</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">absolute_position</span>)</span><br />
      Reflects the nominated 3D point around the plane of the specified 
      object and returns three floating point values representing the x, y 
      and z components of the new point.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_ObjectRootFunc.get_reflect">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.obj._object._ObjectRootFunc-class.html#get_same_side" class="summary-sig-name">get_same_side</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">coordinates_start</span>,
        <span class="summary-sig-arg">coordinates_end</span>)</span><br />
      Returns a single integer value, either 0 (false) or 1 (true), 
      depending on whether the two nominated points are on the same side of
      the specified object's plane equation.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_ObjectRootFunc.get_same_side">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__init__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__str__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Properties</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Properties"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.obj._object._ObjectRootFunc-class.html#eco_id" class="summary-name">eco_id</a><br />
      Id of the object
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.obj._object._ObjectRootFunc-class.html#exposure" class="summary-name">exposure</a><br />
      This command retrieves the surface area of an object that is exposed 
      to outside conditions.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.obj._object._ObjectRootFunc-class.html#pt_even" class="summary-name">pt_even</a><br />
      Retrieves information about how sample points are evenly distributed 
      across an object.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.obj._object._ObjectRootFunc-class.html#pt_random" class="summary-name">pt_random</a><br />
      Retrieves information about how sample points are randomly 
      distributed across an object.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.obj._object._ObjectRootFunc-class.html#sun_angles" class="summary-name">sun_angles</a><br />
      Returns the objects vertical shadow angle (VSA, always assuming it as
      a vertical surface) and horizontal shadow angle (HSA), given in 
      decimal degrees.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.obj._object._ObjectRootFunc-class.html#underground" class="summary-name">underground</a><br />
      Gets the surface area that is underground.
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="get_distance_to"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_distance_to</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">absolute_position</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_ObjectRootFunc.get_distance_to">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns a single floating point value, being the distance between the 
  specified object and the specified 3D point. If this is a POINT object, 
  the distance is the point-to-point distance. If the object is planar, it 
  is the distance of the specified point in line with the plane of the 
  object, even if this point is outside the object's boundaries.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>absolute_position A list of three values that represents the absolute 
  position in the X, Y and Z axis of a point in 3 dimensional model 
  space.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>dist The distance fro the point to the object.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_incidence"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_incidence</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">coordinates</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_ObjectRootFunc.get_incidence">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the angle in degrees between the surface normal of the 
  specified object and the nominated 3D point. This is effectively the 
  incidence angle of a ray fired towards the geometric centre of the object
  from the nominated point. If the object is not planar, the angle value 
  returned will be in relation to the positive x axis.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>coordinates A list of three values that are the x, y, z coordinates of
  the point to check in relation to the object.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>angle The incidence angle in degrees.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_inside"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_inside</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">coordinates</span>,
        <span class="sig-arg">checkChildren</span>=<span class="sig-default">True</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_ObjectRootFunc.get_inside">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Determines if the specified point is within the boundary of the 
  specified object, either 0 for false or 1 for true. This command 
  obviously only works for closed planar objects.</p>
  <p>Note: It is assumed that the specified point is very close to being 
  co-planar with the object. If it lies any signficiant distance away from 
  the surface, invalid results are likely.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>coordinates A list of three values that are the coordinates of the 
  point to check in relation to the object.</p>
  <p>[checkChildren] If the specified object contains child objects (such 
  as WINDOWS, DOORS, VOIDS and PANELS), by default the nominated point is 
  checked against these as well. If the point is inside a child object, the
  result will be false. However, you can set the optional checkChildren 
  parameter to false to avoid this check.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>inside A boolean value where 1 means that the point is inside and 0 
  means that it isn't.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_intersect"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_intersect</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">coordinates_start</span>,
        <span class="sig-arg">coordinates_end</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_ObjectRootFunc.get_intersect">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the coordinates of the intersection point between a line 
  joining the two nominated points with the plane of the specified object. 
  This command only works with planar objects.</p>
  <p>The intersection point can occur anywhere along the line, both between
  the points and either side.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>coordinates_start A list of 3 values of x1, y1, z1 that are the 3D 
  start point of the intersecting line.</p>
  <p>coordinates_end A list of 3 values of x2, y2, z2 that are the 3D end 
  point of the intersecting line.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>x, y, z Represents the absolute position in the X, Y and Z axis of the
  intersection point in 3 dimensional model space.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_pt_initialise"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_pt_initialise</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">fraction</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_ObjectRootFunc.get_pt_initialise">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Many analysis functions require a range of sample points distributed 
  over an object's surface or along its length. This property allows you to
  initiate this process for the specified object. The returned value is a 
  single integer value either 0 (false) or 1 (true) depending on whether 
  points were found, which will allow the process to continue. See 
  get.object.pt.rand and get.object.pt.even for more information.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>fraction A multiplier to control the density of points over the 
  object's surface. By default this is configured as a 25x25 grid with a 
  value of 1. Thus, a factor value of 4 would result in a 100x100 grid, 
  while a factor value of 0.2 would result in a 5x5 grid.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>valid A boolean value where 1 represents success and 0 means that the 
  object is unsuitable for this.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_reflect"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_reflect</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">absolute_position</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_ObjectRootFunc.get_reflect">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Reflects the nominated 3D point around the plane of the specified 
  object and returns three floating point values representing the x, y and 
  z components of the new point. This command only works for planar 
  objects.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>absolute_position A list of 3 values that represents the absolute 
  position in the X, Y and Z axis of a point in 3 dimensional model 
  space.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>absolute_position A lost of three values that represent the absolute 
  position in the X, Y and Z axis of the reflected point in 3 dimensional 
  model space.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_same_side"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_same_side</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">coordinates_start</span>,
        <span class="sig-arg">coordinates_end</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_ObjectRootFunc.get_same_side">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns a single integer value, either 0 (false) or 1 (true), 
  depending on whether the two nominated points are on the same side of the
  specified object's plane equation. This command only works for planar 
  objects.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>coordinates_start A list of three values that are the x1 y1 z1 of the 
  first 3D point to use for the comparison.</p>
  <p>coordinates_end A list of three values that are the x2 y2 z2 of the 
  second 3D point to use for the comparison.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>same A boolean value where 1 means that the points are on the same 
  side and 0 means that they aren't.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== PROPERTY DETAILS ==================== -->
<a name="section-PropertyDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Property Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-PropertyDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="eco_id"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">eco_id</h3>
  <p>Id of the object</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Id of the object
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="exposure"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">exposure</h3>
  <p>This command retrieves the surface area of an object that is exposed 
  to outside conditions. This command only works for planar objects.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the requested object data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - This command retrieves the surface area of an object that is exposed to 
outside conditions.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="pt_even"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">pt_even</h3>
  <p>Retrieves information about how sample points are evenly distributed 
  across an object. Note that this command can only be used after a 
  previous call to get.object.pt.initialise, as this specifies the object 
  to be used and the density of subsequent points.</p>
  <p>Four values are returned - the first three are floating point values 
  representing the x, y and z components of a subsequent point within the 
  object. The fourth value is an integer, corresponding with the Object 
  Point Results table.</p>
  <p>This last value must be checked for a value of 0 to denote that the 
  process is complete.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>x, y, z Represents the absolute position in the X, Y and Z axis of a 
  point on the object surface or length.</p>
  <p>valid A result indicator where 1 represents a valid point, -1 a point 
  that is outside the object and should be ignored, and 0 means the process
  if complete and all parts of the object checked.</p>
  <p>Relevant Data Table(s) Object Point Results Value Description 1 A 
  valid point within the object was found. -1 An invalid point outside the 
  object was found. 0 Finished - no further points to be found.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves information about how sample points are evenly distributed across
an object.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="pt_random"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">pt_random</h3>
  <p>Retrieves information about how sample points are randomly distributed
  across an object. Note that this command can only be used after a 
  previous call to get.object.pt.initialise, as this specifies the object 
  to be used and the density of subsequent points.</p>
  <p>Four values are returned - the first three are floating point values 
  representing the x, y and z components of a subsequent point within the 
  object. The fourth value is an integer, corresponding with the following 
  table.</p>
  <p>This last value must be checked for a value of 0 to denote that the 
  process is complete.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>x, y, z Represents the absolute position in the X, Y and Z axis of a 
  point on the object surface or length.</p>
  <p>valid A result indicator where 1 represents a valid point, -1 a point 
  that is outside the object and should be ignored, and 0 means the process
  if complete and all parts of the object checked.</p>
  <p>Relevant Data Table(s)</p>
  <p>Object Point Results Value Description 1 A valid point within the 
  object was found. -1 An invalid point outside the object was found. 0 
  Finished - no further points to be found.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves information about how sample points are randomly distributed 
across an object.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="sun_angles"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">sun_angles</h3>
  <p>Returns the objects vertical shadow angle (VSA, always assuming it as 
  a vertical surface) and horizontal shadow angle (HSA), given in decimal 
  degrees.</p>
  <p>Note: As these values are always given in relation to the azimuth of 
  the object, the object's tilt angle can be set in relation to this common
  base.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>VSA The Vertical Shadow Angle of the object at the current date and 
  time.</p>
  <p>HSA The Horizontal Shadow Angle of the object at the current date and 
  time.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Returns the objects vertical shadow angle (VSA, always assuming it as a 
vertical surface) and horizontal shadow angle (HSA), given in decimal 
degrees.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="underground"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">underground</h3>
  <p>Gets the surface area that is underground.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the requested object data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Gets the surface area that is underground.
    </dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Fri Aug 28 01:29:48 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
